Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GO-4459: REST API Docs & Refinement #2073

Draft
wants to merge 33 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
e56c6a3
GO-4459: Add descriptions for swagger data models
jmetrikat Jan 29, 2025
c7acd87
GO-4459: Add swagger examples for errors
jmetrikat Jan 29, 2025
cfbe613
GO-4459: Return proper api errors and 423 from middleware
jmetrikat Jan 31, 2025
8697546
GO-4459: Add last_modified sort criterion as fallback for last_opened…
jmetrikat Feb 3, 2025
6f238c4
GO-4459: Add ANYTYPE_API_DEBUG to run config
jmetrikat Feb 3, 2025
e4fa847
GO-4459: Add endpoint for single space
jmetrikat Feb 9, 2025
da52990
GO-4459: Add missing relation keys in GetSpace
jmetrikat Feb 9, 2025
2010b1a
GO-4459: Add endpoint for single member
jmetrikat Feb 9, 2025
544d948
GO-4459: Add handlers and routes for list endpoints
jmetrikat Feb 12, 2025
526de3c
GO-4459: Add initial list service implementation
jmetrikat Feb 12, 2025
44b1bcc
GO-4459: Fix v1 route path for lists
jmetrikat Feb 12, 2025
fd62a25
GO-4459: Fix ObjectSearchSubscribe panic
jmetrikat Feb 14, 2025
dcb8a99
GO-4459: Remove UpdateObjectsInList handler and route
jmetrikat Feb 14, 2025
cd836a6
GO-4459: Return 404 for deleted object
jmetrikat Feb 14, 2025
4034951
GO-4459: Refactor data models to include 'object' property and return…
jmetrikat Feb 14, 2025
81cdd2e
GO-4459: Add relation format to detail entries
jmetrikat Feb 14, 2025
039739f
GO-4459: Get type directly from details in GetObject and fix detail k…
jmetrikat Feb 14, 2025
280d63c
GO-4459: Return custom relations in details of object response
jmetrikat Feb 15, 2025
820a894
GO-4459: Add exclusion of system relations in object details
jmetrikat Feb 15, 2025
ce783a7
GO-4459: Fix security definition to ApiKey auth
jmetrikat Feb 16, 2025
0a0ef53
GO-4459: Upgrade to OpenAPI specification v3.1 and swaggo/swag v2
jmetrikat Feb 16, 2025
1c87b86
GO-4459: Add http prefix to host
jmetrikat Feb 16, 2025
5b5da7d
GO-4459: Add `swagger` Make target to generate and format swagger docs
jmetrikat Feb 16, 2025
58c5c9b
GO-4459 Merge branch 'main' into GO-4459-rest-api-docs
jmetrikat Feb 16, 2025
fd66a26
GO-4459: Add resolveTag method to handle tag/status option as string …
jmetrikat Feb 16, 2025
cdf1787
GO-4459: Add layout align to excluded relations
jmetrikat Feb 17, 2025
ff88402
GO-4459: Add missing filter condition for relation name resolution
jmetrikat Feb 17, 2025
394922d
GO-4459: Fix tests for space and object
jmetrikat Feb 17, 2025
79e72a5
GO-4459: Remove templates from search and object list results
jmetrikat Feb 17, 2025
fefb3b8
GO-4459: Fix tags in search test
jmetrikat Feb 17, 2025
09accae
GO-4459 Merge branch 'main' into GO-4459-rest-api-docs
jmetrikat Feb 17, 2025
4df66f6
GO-4459: Add endpoint descriptions
jmetrikat Feb 20, 2025
8935a5b
GO-4459: Set metadata header with API version
jmetrikat Feb 21, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .run/Run.run.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<env name="ANYTYPE_GATEWAY_ADDR" value="127.0.0.1:31006" />
<env name="ANYTYPE_GRPC_ADDR" value="127.0.0.1:31007" />
<env name="ANYTYPE_GRPCWEB_ADDR" value="127.0.0.1:31008" />
<env name="ANYTYPE_API_DEBUG" value="1" />
<env name="CC" value="/usr/bin/cc" />
<env name="CXX" value="/usr/bin/c++" />
<env name="CGO_CFLAGS" value="-Wno-deprecated-declarations -Wno-deprecated-non-prototype -Wno-xor-used-as-pow" />
Expand Down
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,12 @@ else
@golangci-lint run -v ./... --new-from-rev=origin/main --timeout 15m --fix
endif

swagger:
@echo 'Generating swagger docs...'
@swag init --v3.1 -q -d core/api -g service.go -o core/api/docs
@echo 'Formatting swagger docs...'
@swag fmt -d core/api

### Tantivy Section

REPO := anyproto/tantivy-go
Expand Down
Loading