Gitea · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gitea Miscellaneous API

13 actions 13 updates phrasing extends openapi/gitea-miscellaneous-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gitea's API. It is a proposal applied on top of the contract, not a document Gitea publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/gitignore/templates'].get
$.paths['/gitignore/templates/{name}'].get
$.paths['/label/templates'].get
$.paths['/label/templates/{name}'].get
$.paths['/licenses'].get
$.paths['/licenses/{name}'].get
$.paths['/markdown'].post
$.paths['/markdown/raw'].post
$.paths['/markup'].post
$.paths['/signing-key.gpg'].get
$.paths['/signing-key.pub'].get
$.paths['/version'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gitea Miscellaneous API
  version: 1.0.0
extends: openapi/gitea-miscellaneous-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/gitignore/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List available .gitignore templates
      effect: read
      questions:
      - Which .gitignore templates can I pick from when creating a repo?
      - Is there a Python or Node .gitignore template available on this server?
      instructions:
      - text: List all the .gitignore templates.
      - text: Show me the available gitignore template names.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitignore/templates/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a .gitignore template's contents
      effect: read
      questions:
      - What does a particular .gitignore template actually contain?
      - Can I preview a gitignore template before using it?
      instructions:
      - text: Show the contents of the {name} gitignore template.
        slots:
          name: path.name
      - text: Get the {name} .gitignore template.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/label/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List available issue label templates
      effect: read
      questions:
      - Which issue label sets can I seed a new repository with?
      - What label templates does this Gitea instance offer?
      instructions:
      - text: List all issue label templates.
      - text: Show me the label template names I can use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/label/templates/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the labels in a label template
      effect: read
      questions:
      - What labels and colors come in a given label template?
      - Can I see every label a template would create?
      instructions:
      - text: Show the labels in the {name} label template.
        slots:
          name: path.name
      - text: List the label names and colors in template {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/licenses'].get
  update:
    x-apievangelist-phrasing:
      intent: List available license templates
      effect: read
      questions:
      - Which open source licenses can I choose when creating a repository?
      - Is MIT or Apache-2.0 available as a license template?
      instructions:
      - text: List all license templates.
      - text: Show the license keys I can pick for a new repo.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/licenses/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a license template's text
      effect: read
      questions:
      - What's the full text of a given license template?
      - Can I fetch a license's body to drop into my LICENSE file?
      instructions:
      - text: Show the text of the {name} license template.
        slots:
          name: path.name
      - text: Get license template {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/markdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Render Markdown to HTML
      effect: read
      questions:
      - How do I preview Markdown as HTML the way Gitea displays it?
      - Can links in rendered Markdown resolve against a specific repo or wiki context?
      instructions:
      - text: 'Render this Markdown as HTML: {Text}.'
        slots:
          Text: requestBody.Text
      - text: Render {Text} in {Mode} mode using repo context {Context}.
        slots:
          Text: requestBody.Text
          Mode: requestBody.Mode
          Context: requestBody.Context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/markdown/raw'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a raw Markdown body to HTML
      effect: read
      questions:
      - Can I send plain Markdown text as the request body and get HTML back?
      - Is there a raw Markdown renderer that doesn't need a JSON wrapper?
      instructions:
      - text: Render this raw Markdown body to HTML without any JSON options.
      - text: Convert my plain-text Markdown file to HTML using the raw endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/markup'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a markup file to HTML
      effect: read
      questions:
      - How do I render non-Markdown markup like Org or AsciiDoc to HTML?
      - Can the renderer pick the markup type from a file path?
      instructions:
      - text: Render {Text} as HTML treating it as file {FilePath}.
        slots:
          Text: requestBody.Text
          FilePath: requestBody.FilePath
      - text: Render markup {Text} for file {FilePath} in {Mode} mode with context {Context}.
        slots:
          Text: requestBody.Text
          FilePath: requestBody.FilePath
          Mode: requestBody.Mode
          Context: requestBody.Context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/signing-key.gpg'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the instance GPG signing key
      effect: read
      questions:
      - What GPG key does this Gitea server use to sign commits it creates?
      - Where can I download the server's signing-key.gpg to trust its commits?
      instructions:
      - text: Download the instance's default GPG signing key.
      - text: Get the server's signing-key.gpg.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/signing-key.pub'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the instance SSH signing key
      effect: read
      questions:
      - Which SSH public key does the server sign commits with?
      - Can I fetch signing-key.pub to verify SSH-signed commits from Gitea?
      instructions:
      - text: Download the instance's default SSH signing key.
      - text: Get the server's signing-key.pub.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Gitea server version
      effect: read
      questions:
      - What version of Gitea is this server running?
      - Is this instance on a recent enough release for a feature I need?
      instructions:
      - text: Tell me the Gitea version of this server.
      - text: Check which Gitea release the instance is running.
      method: generated
      generated: '2026-09-26'