Upgrade Growstuff API Schema to OpenAPI 3.0 for GPT Integration

[spencerthayer]

Objective

Convert Growstuff's Swagger 2.0 API schema to OpenAPI 3.0 to facilitate GPT-based application integrations.

Tasks

1. Schema Conversion

Update the schema to OpenAPI 3.0, ensuring compliance with the latest standards. Helpful resources:

• OpenAPI Specification: GitHub repository
• Swagger Editor for validation: https://editor.swagger.io/

2. Enhance Documentation

Include examples and detailed endpoint descriptions. Resources for documentation standards:

• OpenAPI Guide: https://swagger.io/docs/specification/about/

3. Validation

Use tools to ensure the schema's correctness.

• Swagger to OpenAPI Converter: https://converter.swagger.io/

4. Testing

Ensure all endpoints work as expected with the new schema.

5. Deployment

Update deployment processes to reflect schema changes.

Conversion Examples

Swagger 2.0 Example for /crops Endpoint:

swagger: '2.0'
paths:
  /crops:
    get:
      summary: List all crops
      produces:
        - application/json
      responses:
        200:
          description: An array of crops
          schema:
            type: array
            items:
              $ref: '#/definitions/Crop'
definitions:
  Crop:
    type: object
    properties:
      name:
        type: string
      description:
        type: string

Converted OpenAPI 3.0 Example for /crops Endpoint:

openapi: 3.0.0
paths:
  /crops:
    get:
      summary: List all crops
      responses:
        '200':
          description: An array of crops
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Crop'
components:
  schemas:
    Crop:
      type: object
      properties:
        name:
          type: string
        description:
          type: string

Expected Outcome

A compatible OpenAPI 3.0 schema for seamless GPT application integration, enhancing API usability and accessibility.

[CloCkWeRX]

Pull requests welcome for this one.

We use jsonapi-swagger:

https://github.com/Growstuff/growstuff/blob/dev/Gemfile#L22

Should have good test coverage as well under spec/requests/API/*

[spencerthayer]

Awesome. I'll look into it. (As soon as I can create an account.)