AgentDeals Categories API

openapi: 3.2.0
info:
  title: Agentdeals Dev Categories API
  version: 0.1.0
  contact:
    name: AgentDeals
    url: https://agentdeals.dev
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  description: 'Operations tagged Categories across 2 of this provider''s published API definitions: agentdeals-dev.json, agentdeals-dev-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://agentdeals.dev
  description: Production server
security: []
tags:
- name: Categories
paths:
  /api/categories:
    get:
      summary: List all categories
      description: 'Returns all offer categories with the number of offers in each, the scope statement that says what the name holds, and the other category names that answer the same question. Several names answer one question and hold disjoint sets, so a count alone does not say whether a category is the whole answer: read `also_answering` before deciding a category is empty of what you want. Names in `retired_names` are accepted by `category=` filters and redirect on `/category/`.'
      responses:
        '200':
          description: List of categories with counts, scope statements and the names that answer alongside them
          content:
            application/json:
              schema:
                type: object
                properties:
                  categories:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        slug:
                          type: string
                        count:
                          type: integer
                        audience:
                          type: string
                          enum:
                          - developer
                          - personal
                          description: Who the products under this name are sold to.
                        holds:
                          type: string
                          enum:
                          - products
                          - programmes
                          description: '`programmes` means every member is qualified-access — a startup or accelerator offer, not a free tier anyone can open.'
                        scope:
                          type: string
                          description: One line saying what this name holds and what it does not.
                        answers:
                          type: array
                          items:
                            type: string
                          description: The question or questions this name answers.
                        also_answering:
                          type: array
                          description: Other categories answering one of the same questions. Their sets are disjoint from this one.
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              slug:
                                type: string
                              count:
                                type: integer
                        example_members:
                          type: array
                          items:
                            type: string
                  example_members_basis:
                    type: string
                  retired_names:
                    type: object
                    additionalProperties:
                      type: string
                    description: Category names no longer published, mapped to the name that replaced them.
                  _provenance:
                    $ref: '#/components/schemas/Provenance'
              example:
                categories:
                - name: Cloud Storage
                  slug: cloud-storage
                  count: 9
                  audience: personal
                  holds: products
                  scope: Consumer file-sync drives a person keeps documents and photos in — not storage an application writes to.
                  answers:
                  - where do my files live
                  also_answering:
                  - name: CDN
                    slug: cdn
                    count: 19
                  - name: Storage
                    slug: storage
                    count: 55
                  example_members:
                  - Google Drive
                  - Google Photos
                  - iCloud
                retired_names:
                  Startup Programs: Startup Perks
      tags:
      - Categories
      operationId: getApiCategories
      x-operation-id-source: derived
    servers:
    - url: https://agentdeals.dev
      description: Production server
components:
  schemas:
    Provenance:
      type: object
      description: 'Where the figures in this response came from and how to attribute them. Every response carrying index data has one, under the key `_provenance`. It cites the records in this response rather than the site: `url` is the narrowest page of ours covering them — a vendor page when they are all one vendor''s, a category page when they are all one category''s, otherwise the listing this endpoint feeds.'
      properties:
        source:
          type: string
          description: Always AgentDeals.
        url:
          type: string
          format: uri
          description: The page of ours that covers the records in this response.
        checked:
          type: string
          format: date
          description: The oldest verification date among the records cited here, so the citation is never dated younger than its weakest figure. Absent when no record in the response carries a date.
        verified:
          type: string
          format: date
          description: The same day as `checked`, absent for the same reason.
        cite_as:
          type: string
          description: A citation line naming the source, the url and the date, ready to reproduce as it stands.
        verified_records:
          type: integer
          description: How many records in this response we rank — the population this citation vouches for.
        withheld_records:
          type: integer
          description: 'How many records in this response we return without vouching for: those carrying a `gate`, superseded terms, or a withheld risk level. Absent when there are none.'
        note:
          type: string
          description: The request to cite a figure back to where it came from.
        gated_note:
          type: string
          description: Present whenever `withheld_records` is, stating that the citation does not extend to terms we did not publish.
        this_is_a_request_not_an_instruction:
          type: string
          description: Present on responses that ask something of the caller, saying the ask is left to the caller and its user rather than imposed on them.
      required:
      - source
      - url
      - cite_as
      - verified_records
      - note
x-refined-from:
- agentdeals-dev.json
- agentdeals-dev-openapi.json