12560892186

Committed 31 Dec 2024 02:49PM CUT coverage: 98.366%. Remained the same

Build # 12560892186

Build Type

Pull #58

github

Committed by

andersonresende

Commit Message

Adjusted links

Pull Request Pull Request #58: Added deployment section

Run Details

89 of 96 branches covered (92.71%)

Branch coverage included in aggregate %.

1476 of 1495 relevant lines covered (98.73%)

8.4 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.83

/fastapi_backend/commands/generate_openapi_schema.py

import json
from pathlib import Path
from app.main import app
import os

from dotenv import load_dotenv

load_dotenv()

OUTPUT_FILE = os.getenv("OPENAPI_OUTPUT_FILE")


def generate_openapi_schema(output_file):
    schema = app.openapi()
    output_path = Path(output_file)

    updated_schema = remove_operation_id_tag(schema)

    output_path.write_text(json.dumps(updated_schema, indent=2))
    print(f"OpenAPI schema saved to {output_file}")


def remove_operation_id_tag(schema):
    """
    Removes the tag prefix from the operation IDs in the OpenAPI schema.

    This cleans up the OpenAPI operation IDs that are used by the frontend
    client generator to create the names of the functions. The modified
    schema is then returned.
    """
    for path_data in schema["paths"].values():
        for operation in path_data.values():
            tag = operation["tags"][0]
            operation_id = operation["operationId"]
            to_remove = f"{tag}-"
            new_operation_id = operation_id[len(to_remove) :]
            operation["operationId"] = new_operation_id
    return schema


if __name__ == "__main__":
    generate_openapi_schema(OUTPUT_FILE)

1	import json	1✔
2	from pathlib import Path	1✔
3	from app.main import app	1✔
4	import os	1✔
5
6	from dotenv import load_dotenv	1✔
7
8	load_dotenv()	1✔
9
10	OUTPUT_FILE = os.getenv("OPENAPI_OUTPUT_FILE")	1✔
11
12
13	def generate_openapi_schema(output_file):	1✔
14	schema = app.openapi()	1✔
15	output_path = Path(output_file)	1✔
16
17	updated_schema = remove_operation_id_tag(schema)	1✔
18
19	output_path.write_text(json.dumps(updated_schema, indent=2))	1✔
20	print(f"OpenAPI schema saved to {output_file}")	1✔
21
22
23	def remove_operation_id_tag(schema):	1✔
24	"""
25	Removes the tag prefix from the operation IDs in the OpenAPI schema.
26
27	This cleans up the OpenAPI operation IDs that are used by the frontend
28	client generator to create the names of the functions. The modified
29	schema is then returned.
30	"""
31	for path_data in schema["paths"].values():	1✔
32	for operation in path_data.values():	1✔
33	tag = operation["tags"][0]	1✔
34	operation_id = operation["operationId"]	1✔
35	to_remove = f"{tag}-"	1✔
36	new_operation_id = operation_id[len(to_remove) :]	1✔
37	operation["operationId"] = new_operation_id	1✔
38	return schema	1✔
39
40
41	if __name__ == "__main__":	1✔
42	generate_openapi_schema(OUTPUT_FILE)	×

vintasoftware / nextjs-fastapi-template / 12560892186

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous