Skip to content

Commit

Permalink
cleanup go mod replace changes
Browse files Browse the repository at this point in the history
  • Loading branch information
pitabwire committed Jan 26, 2024
1 parent d16f864 commit 90961fa
Show file tree
Hide file tree
Showing 29 changed files with 433 additions and 364 deletions.
33 changes: 16 additions & 17 deletions go/files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@
An openAPI 3.0 specification that defines how files are stored and accessed on ant investor products

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using
the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://antinvestor.com](https://antinvestor.com)
For more information, please visit [https://antinvestor.com](https://antinvestor.com)

## Installation

Expand Down Expand Up @@ -47,8 +45,7 @@ ctx := context.WithValue(context.Background(), file_v1.ContextServerIndex, 1)

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context
value `file_v1.ContextServerVariables` of type `map[string]string`.
Templated server URL is formatted using default variables from configuration or from context value `file_v1.ContextServerVariables` of type `map[string]string`.

```go
ctx := context.WithValue(context.Background(), file_v1.ContextServerVariables, map[string]string{
Expand All @@ -62,8 +59,7 @@ Note, enum values are always validated and all unused variables are silently ign

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by
using `file_v1.ContextOperationServerIndices` and `file_v1.ContextOperationServerVariables` context maps.
Similar rules for overriding default operation server index and variables applies by using `file_v1.ContextOperationServerIndices` and `file_v1.ContextOperationServerVariables` context maps.

```go
ctx := context.WithValue(context.Background(), file_v1.ContextOperationServerIndices, map[string]int{
Expand All @@ -80,22 +76,24 @@ ctx = context.WithValue(context.Background(), file_v1.ContextOperationServerVari

All URIs are relative to *https://files.api.antinvestor.com*

Class | Method | HTTP request | Description
--------------|-----------------------------------------------------|------------------|-------------
*DefaultAPI* | [**AddFile**](docs/DefaultAPI.md#addfile) | **Post** / |
*DefaultAPI* | [**DeleteFile**](docs/DefaultAPI.md#deletefile) | **Delete** /{id} |
*DefaultAPI* | [**FindFileById**](docs/DefaultAPI.md#findfilebyid) | **Get** /{id} |
*DefaultAPI* | [**FindFiles**](docs/DefaultAPI.md#findfiles) | **Get** / |
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultAPI* | [**AddFile**](docs/DefaultAPI.md#addfile) | **Post** / |
*DefaultAPI* | [**DeleteFile**](docs/DefaultAPI.md#deletefile) | **Delete** /{id} |
*DefaultAPI* | [**FindFileById**](docs/DefaultAPI.md#findfilebyid) | **Get** /{id} |
*DefaultAPI* | [**FindFiles**](docs/DefaultAPI.md#findfiles) | **Get** / |


## Documentation For Models

- [Error](docs/Error.md)
- [File](docs/File.md)
- [Error](docs/Error.md)
- [File](docs/File.md)


## Documentation For Authorization

Authentication schemes defined for the API:

Authentication schemes defined for the API:
### bearerAuth

- **Type**: HTTP Bearer token authentication
Expand All @@ -107,6 +105,7 @@ auth := context.WithValue(context.Background(), file_v1.ContextAccessToken, "BEA
r, err := client.Service.Operation(auth, args)
```


## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains
Expand Down
140 changes: 70 additions & 70 deletions go/files/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,61 +13,61 @@ info:
title: Ant Investor Files
version: 1.0.0
servers:
- url: https://files.api.antinvestor.com
- url: https://files.api.antinvestor.com
security:
- bearerAuth: [ ]
- bearerAuth: []
paths:
/:
get:
description: |
Returns all files from the system that the user has access to
operationId: findFiles
parameters:
- description: filters the files by the subscription by
explode: true
in: query
name: owner_id
required: false
schema:
example: 9bsv0s09a5j002njlpvg
pattern: "[0-9a-z_-]{3,20}"
type: string
style: form
- description: filters the files by the grouping id
explode: true
in: query
name: group_id
required: false
schema:
example: 9bsv0s09a5j002njlptg
pattern: "[0-9a-z_-]{3,20}"
type: string
style: form
- description: filters the files by the sub grouping id
explode: true
in: query
name: sub_group_id
required: false
schema:
example: front side
type: string
style: form
- description: maximum number of results to return
explode: true
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: maximum number of results to return
explode: true
in: query
name: page
required: false
schema:
type: integer
style: form
- description: filters the files by the subscription by
explode: true
in: query
name: owner_id
required: false
schema:
example: 9bsv0s09a5j002njlpvg
pattern: "[0-9a-z_-]{3,20}"
type: string
style: form
- description: filters the files by the grouping id
explode: true
in: query
name: group_id
required: false
schema:
example: 9bsv0s09a5j002njlptg
pattern: "[0-9a-z_-]{3,20}"
type: string
style: form
- description: filters the files by the sub grouping id
explode: true
in: query
name: sub_group_id
required: false
schema:
example: front side
type: string
style: form
- description: maximum number of results to return
explode: true
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: maximum number of results to return
explode: true
in: query
name: page
required: false
schema:
type: integer
style: form
responses:
"200":
content:
Expand Down Expand Up @@ -123,16 +123,16 @@ paths:
description: deletes a single file based on the ID supplied
operationId: deleteFile
parameters:
- description: ID of file to delete
explode: false
in: path
name: id
required: true
schema:
example: 9bsv0s09a5j002njlq20
pattern: "[0-9a-z_-]{3,20}"
type: string
style: simple
- description: ID of file to delete
explode: false
in: path
name: id
required: true
schema:
example: 9bsv0s09a5j002njlq20
pattern: "[0-9a-z_-]{3,20}"
type: string
style: simple
responses:
"204":
description: file deleted
Expand All @@ -152,16 +152,16 @@ paths:
description: Returns a file based on supplied ID
operationId: find file by id
parameters:
- description: ID of file to fetch
explode: false
in: path
name: id
required: true
schema:
example: 9bsv0s09a5j002njlq30
pattern: "[0-9a-z_-]{3,20}"
type: string
style: simple
- description: ID of file to fetch
explode: false
in: path
name: id
required: true
schema:
example: 9bsv0s09a5j002njlq30
pattern: "[0-9a-z_-]{3,20}"
type: string
style: simple
responses:
"200":
content:
Expand Down Expand Up @@ -219,7 +219,7 @@ components:
url:
type: string
required:
- name
- name
Error:
properties:
code:
Expand All @@ -228,8 +228,8 @@ components:
message:
type: string
required:
- code
- message
- code
- message
UnauthorizedError:
description: Access token is missing or invalid
addFile_request:
Expand Down
Loading

0 comments on commit 90961fa

Please sign in to comment.