3GPP Scout Rfcs API

openapi: 3.2.0
info:
  title: 3gppscout Com Rfcs API
  version: 0.2.0
  description: 'Operations tagged rfcs across 2 of this provider''s published API definitions: 3gppscout-com-openapi.json, api.json. Each path carries the servers of the definition it was published in.'
tags:
- name: rfcs
paths:
  /rfcs/search:
    post:
      tags:
      - rfcs
      summary: Search Ietf Rfcs
      description: 'Search the IETF RFCs that 3GPP specs depend on (SIP, SDP, Diameter, SCTP, QUIC, HTTP/2, OAuth, RTP, DetNet, IGP Flex-Algo and more), by meaning and by exact term.


        Use when a question is about a protocol the IETF defines and 3GPP references, or when a 3GPP clause says

        "as defined in RFC xxxx". The corpus is every RFC a current 3GPP spec cites (obsoleted ones included,

        since specs cite them by number) plus the current RFCs of the transport and signalling working groups.

        It holds no Internet-Drafts. RFC numbers in the query (for example "RFC 3261") bring in that RFC''s passages.

        For 3GPP''s own text use search_text; this tool never returns 3GPP clauses.


        Each result is one passage with its RFC number, title, section number and title, verbatim text, a link to

        the section on rfc-editor.org (url), status, obsoleted_by and updated_by, the attribution line to show with

        any quote, and cited_by: the 3GPP clauses that name this RFC (read one with get_sections). Call

        get_rfc_section for a whole section or an RFC''s outline.


        Quoting rules: at most 100 words per excerpt and 300 words from one RFC per answer, verbatim, each with its

        attribution line.


        Errors: 400 `invalid_parameter`, 502 `search_unavailable`.'
      operationId: search_ietf_rfcs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RfcSearchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /rfcs/{rfc_number}:
    get:
      tags:
      - rfcs
      summary: Get Rfc Section
      description: 'Read one IETF RFC section verbatim, or an RFC''s outline, from the RFCs that 3GPP depends on.


        Without `section`: the RFC''s title, status, obsoletes, obsoleted_by and updated_by, abstract, every section

        number and title, the 3GPP clauses that cite it (cited_by), and the official link. With `section`: that

        section''s text verbatim (one section per call, at most 2,000 words), its subsections, the section link and

        the attribution line to show with any quote.


        Quoting rules: at most 100 words per excerpt and 300 words from one RFC per answer, verbatim, each with its

        attribution line.


        Errors: 404 `rfc_not_indexed` (the RFC is not in the corpus; the official link is returned), 404

        `section_not_found` (the section numbers are returned), 502 `rfc_unavailable`.'
      operationId: get_rfc_section
      parameters:
      - name: rfc_number
        in: path
        required: true
        schema:
          type: integer
          maximum: 99999
          minimum: 1
          description: RFC number, e.g. 9350.
          title: Rfc Number
        description: RFC number, e.g. 9350.
      - name: section
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          description: Section number to read verbatim, e.g. '5.1', 'A.2' or 'abstract'. Omit for the RFC's outline.
          title: Section
        description: Section number to read verbatim, e.g. '5.1', 'A.2' or 'abstract'. Omit for the RFC's outline.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    RfcSearchRequest:
      properties:
        query:
          type: string
          maxLength: 1000
          minLength: 2
          title: Query
          description: What the RFC text should say, in plain words or exact terms, e.g. 'SCTP path failure detection', 'Flex-Algo prefix advertisement', 'RFC 3261 3xx response handling'.
        rfcs:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Rfcs
          description: Only these RFC numbers, e.g. [3261, 3264].
        include_obsoleted:
          type: boolean
          title: Include Obsoleted
          description: Include RFCs that a later RFC obsoletes. 3GPP specs often cite those by number.
          default: true
        cited_only:
          type: boolean
          title: Cited Only
          description: Only RFCs that a current 3GPP spec cites.
          default: false
        top_k:
          type: integer
          maximum: 20.0
          minimum: 1.0
          title: Top K
          description: Passages to return.
          default: 5
        max_per_rfc:
          type: integer
          maximum: 5.0
          minimum: 1.0
          title: Max Per Rfc
          description: At most this many passages from one RFC. Use 1 for a list of distinct RFCs.
          default: 2
        include_text:
          type: boolean
          title: Include Text
          description: Include each passage's text.
          default: true
      type: object
      required:
      - query
      title: RfcSearchRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
x-refined-from:
- 3gppscout-com-openapi.json
- api.json